<!DOCTYPE HTML>

<html lang="en">
<head>

<title>AbstractJaasAuthenticationProvider (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="AbstractJaasAuthenticationProvider (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="AbstractJaasAuthenticationProvider.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.authentication.jaas</a></div>
<h2 title="Class AbstractJaasAuthenticationProvider" class="title">Class AbstractJaasAuthenticationProvider</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.authentication.jaas.AbstractJaasAuthenticationProvider</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.util.EventListener</code>, <code>org.springframework.beans.factory.Aware</code>, <code>org.springframework.beans.factory.InitializingBean</code>, <code>org.springframework.context.ApplicationEventPublisherAware</code>, <code>org.springframework.context.ApplicationListener&lt;<a href="../../core/session/SessionDestroyedEvent.html" title="class in org.springframework.security.core.session">SessionDestroyedEvent</a>&gt;</code>, <code><a href="../AuthenticationProvider.html" title="interface in org.springframework.security.authentication">AuthenticationProvider</a></code></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><code><a href="DefaultJaasAuthenticationProvider.html" title="class in org.springframework.security.authentication.jaas">DefaultJaasAuthenticationProvider</a></code>, <code><a href="JaasAuthenticationProvider.html" title="class in org.springframework.security.authentication.jaas">JaasAuthenticationProvider</a></code></dd>
</dl>
<hr>
<pre>public abstract class <span class="typeNameLabel">AbstractJaasAuthenticationProvider</span>
extends java.lang.Object
implements <a href="../AuthenticationProvider.html" title="interface in org.springframework.security.authentication">AuthenticationProvider</a>, org.springframework.context.ApplicationEventPublisherAware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener&lt;<a href="../../core/session/SessionDestroyedEvent.html" title="class in org.springframework.security.core.session">SessionDestroyedEvent</a>&gt;</pre>
<div class="block">An <a href="../AuthenticationProvider.html" title="interface in org.springframework.security.authentication"><code>AuthenticationProvider</code></a> implementation that retrieves user details from a
JAAS login configuration.
<p>
This <code>AuthenticationProvider</code> is capable of validating
<a href="../UsernamePasswordAuthenticationToken.html" title="class in org.springframework.security.authentication"><code>UsernamePasswordAuthenticationToken</code></a>
requests contain the correct username and password.
<p>
This implementation is backed by a
<a href="https://java.sun.com/j2se/1.5.0/docs/guide/security/jaas/JAASRefGuide.html">
JAAS</a> configuration that is provided by a subclass's implementation of
<a href="AbstractJaasAuthenticationProvider.html#createLoginContext(javax.security.auth.callback.CallbackHandler)"><code>createLoginContext(CallbackHandler)</code></a>.
<p>
When using JAAS login modules as the authentication source, sometimes the <a href="https://java.sun.com/j2se/1.5.0/docs/api/javax/security/auth/login/LoginContext.html"> LoginContext</a> will require <i>CallbackHandler</i>s. The
AbstractJaasAuthenticationProvider uses an internal <a href="https://java.sun.com/j2se/1.5.0/docs/api/javax/security/auth/callback/CallbackHandler.html">CallbackHandler </a> to wrap the <a href="JaasAuthenticationCallbackHandler.html" title="interface in org.springframework.security.authentication.jaas"><code>JaasAuthenticationCallbackHandler</code></a>s configured
in the ApplicationContext. When the LoginContext calls the internal CallbackHandler,
control is passed to each <a href="JaasAuthenticationCallbackHandler.html" title="interface in org.springframework.security.authentication.jaas"><code>JaasAuthenticationCallbackHandler</code></a> for each Callback
passed.
<p>
<a href="JaasAuthenticationCallbackHandler.html" title="interface in org.springframework.security.authentication.jaas"><code>JaasAuthenticationCallbackHandler</code></a>s are passed to the
AbstractJaasAuthenticationProvider through the
<a href="AbstractJaasAuthenticationProvider.html#setCallbackHandlers(org.springframework.security.authentication.jaas.JaasAuthenticationCallbackHandler%5B%5D)"><code>callbackHandlers</code></a> property.
<pre> &lt;property name="callbackHandlers"&gt;
   &lt;list&gt;
     &lt;bean class="org.springframework.security.authentication.jaas.TestCallbackHandler"/&gt;
     &lt;bean class="<a href="JaasNameCallbackHandler.html" title="class in org.springframework.security.authentication.jaas"><code>org.springframework.security.authentication.jaas.JaasNameCallbackHandler</code></a>"/&gt;
     &lt;bean class="<a href="JaasPasswordCallbackHandler.html" title="class in org.springframework.security.authentication.jaas"><code>org.springframework.security.authentication.jaas.JaasPasswordCallbackHandler</code></a>"/&gt;
  &lt;/list&gt;
 &lt;/property&gt;
 </pre>
<p>
After calling LoginContext.login(), the AbstractJaasAuthenticationProvider will
retrieve the returned Principals from the Subject
(LoginContext.getSubject().getPrincipals). Each returned principal is then passed to
the configured <a href="AuthorityGranter.html" title="interface in org.springframework.security.authentication.jaas"><code>AuthorityGranter</code></a>s. An AuthorityGranter is a mapping between a
returned Principal, and a role name. If an AuthorityGranter wishes to grant an
Authorization a role, it returns that role name from it's
<a href="AuthorityGranter.html#grant(java.security.Principal)"><code>AuthorityGranter.grant(java.security.Principal)</code></a> method. The returned role will
be applied to the Authorization object as a <a href="../../core/GrantedAuthority.html" title="interface in org.springframework.security.core"><code>GrantedAuthority</code></a>.
<p>
AuthorityGranters are configured in spring xml as follows...
<pre> &lt;property name="authorityGranters"&gt;
   &lt;list&gt;
     &lt;bean class="org.springframework.security.authentication.jaas.TestAuthorityGranter"/&gt;
   &lt;/list&gt;
  &lt;/property&gt;
 </pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">

</a>
<h3>Field Summary</h3>
<table class="memberSummary">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.commons.logging.Log</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#log">log</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">

</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#%3Cinit%3E()">AbstractJaasAuthenticationProvider</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#afterPropertiesSet()">afterPropertiesSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Validates the required properties are set.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#authenticate(org.springframework.security.core.Authentication)">authenticate</a></span>&#8203;(<a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;auth)</code></th>
<td class="colLast">
<div class="block">Attempts to login the user given the Authentication objects principal and
credential</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected abstract javax.security.auth.login.LoginContext</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#createLoginContext(javax.security.auth.callback.CallbackHandler)">createLoginContext</a></span>&#8203;(javax.security.auth.callback.CallbackHandler&nbsp;handler)</code></th>
<td class="colLast">
<div class="block">Creates the LoginContext to be used for authentication.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>protected org.springframework.context.ApplicationEventPublisher</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#getApplicationEventPublisher()">getApplicationEventPublisher</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#handleLogout(org.springframework.security.core.session.SessionDestroyedEvent)">handleLogout</a></span>&#8203;(<a href="../../core/session/SessionDestroyedEvent.html" title="class in org.springframework.security.core.session">SessionDestroyedEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Handles the logout by getting the security contexts for the destroyed session and
invoking <code>LoginContext.logout()</code> for any which contain a
<code>JaasAuthenticationToken</code>.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#onApplicationEvent(org.springframework.security.core.session.SessionDestroyedEvent)">onApplicationEvent</a></span>&#8203;(<a href="../../core/session/SessionDestroyedEvent.html" title="class in org.springframework.security.core.session">SessionDestroyedEvent</a>&nbsp;event)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#publishFailureEvent(org.springframework.security.authentication.UsernamePasswordAuthenticationToken,org.springframework.security.core.AuthenticationException)">publishFailureEvent</a></span>&#8203;(<a href="../UsernamePasswordAuthenticationToken.html" title="class in org.springframework.security.authentication">UsernamePasswordAuthenticationToken</a>&nbsp;token,
<a href="../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a>&nbsp;ase)</code></th>
<td class="colLast">
<div class="block">Publishes the <a href="event/JaasAuthenticationFailedEvent.html" title="class in org.springframework.security.authentication.jaas.event"><code>JaasAuthenticationFailedEvent</code></a>.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#publishSuccessEvent(org.springframework.security.authentication.UsernamePasswordAuthenticationToken)">publishSuccessEvent</a></span>&#8203;(<a href="../UsernamePasswordAuthenticationToken.html" title="class in org.springframework.security.authentication">UsernamePasswordAuthenticationToken</a>&nbsp;token)</code></th>
<td class="colLast">
<div class="block">Publishes the <a href="event/JaasAuthenticationSuccessEvent.html" title="class in org.springframework.security.authentication.jaas.event"><code>JaasAuthenticationSuccessEvent</code></a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)">setApplicationEventPublisher</a></span>&#8203;(org.springframework.context.ApplicationEventPublisher&nbsp;applicationEventPublisher)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#setAuthorityGranters(org.springframework.security.authentication.jaas.AuthorityGranter%5B%5D)">setAuthorityGranters</a></span>&#8203;(<a href="AuthorityGranter.html" title="interface in org.springframework.security.authentication.jaas">AuthorityGranter</a>[]&nbsp;authorityGranters)</code></th>
<td class="colLast">
<div class="block">Set the AuthorityGranters that should be consulted for role names to be granted to
the Authentication.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#setCallbackHandlers(org.springframework.security.authentication.jaas.JaasAuthenticationCallbackHandler%5B%5D)">setCallbackHandlers</a></span>&#8203;(<a href="JaasAuthenticationCallbackHandler.html" title="interface in org.springframework.security.authentication.jaas">JaasAuthenticationCallbackHandler</a>[]&nbsp;callbackHandlers)</code></th>
<td class="colLast">
<div class="block">Set the JAASAuthentcationCallbackHandler array to handle callback objects generated
by the LoginContext.login method.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#setLoginContextName(java.lang.String)">setLoginContextName</a></span>&#8203;(java.lang.String&nbsp;loginContextName)</code></th>
<td class="colLast">
<div class="block">Set the loginContextName, this name is used as the index to the configuration
specified in the loginConfig property.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#setLoginExceptionResolver(org.springframework.security.authentication.jaas.LoginExceptionResolver)">setLoginExceptionResolver</a></span>&#8203;(<a href="LoginExceptionResolver.html" title="interface in org.springframework.security.authentication.jaas">LoginExceptionResolver</a>&nbsp;loginExceptionResolver)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="AbstractJaasAuthenticationProvider.html#supports(java.lang.Class)">supports</a></span>&#8203;(java.lang.Class&lt;?&gt;&nbsp;aClass)</code></th>
<td class="colLast">
<div class="block">Returns <code>true</code> if this <Code>AuthenticationProvider</Code> supports the
indicated <Code>Authentication</Code> object.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.detail">

</a>
<h3>Field Detail</h3>
<a id="log">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>log</h4>
<pre>protected final&nbsp;org.apache.commons.logging.Log log</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">

</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractJaasAuthenticationProvider</h4>
<pre>public&nbsp;AbstractJaasAuthenticationProvider()</pre>
</li>
</ul>
</li>
</ul>
</section>

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="afterPropertiesSet()">

</a>
<ul class="blockList">
<li class="blockList">
<h4>afterPropertiesSet</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterPropertiesSet()
                        throws java.lang.Exception</pre>
<div class="block">Validates the required properties are set. In addition, if
<a href="AbstractJaasAuthenticationProvider.html#setCallbackHandlers(org.springframework.security.authentication.jaas.JaasAuthenticationCallbackHandler%5B%5D)"><code>setCallbackHandlers(JaasAuthenticationCallbackHandler[])</code></a> has not been
called with valid handlers, initializes to use <a href="JaasNameCallbackHandler.html" title="class in org.springframework.security.authentication.jaas"><code>JaasNameCallbackHandler</code></a> and
<a href="JaasPasswordCallbackHandler.html" title="class in org.springframework.security.authentication.jaas"><code>JaasPasswordCallbackHandler</code></a>.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>afterPropertiesSet</code>&nbsp;in interface&nbsp;<code>org.springframework.beans.factory.InitializingBean</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.Exception</code></dd>
</dl>
</li>
</ul>
<a id="authenticate(org.springframework.security.core.Authentication)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>authenticate</h4>
<pre class="methodSignature">public&nbsp;<a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;authenticate&#8203;(<a href="../../core/Authentication.html" title="interface in org.springframework.security.core">Authentication</a>&nbsp;auth)
                            throws <a href="../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a></pre>
<div class="block">Attempts to login the user given the Authentication objects principal and
credential</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../AuthenticationProvider.html#authenticate(org.springframework.security.core.Authentication)">authenticate</a></code>&nbsp;in interface&nbsp;<code><a href="../AuthenticationProvider.html" title="interface in org.springframework.security.authentication">AuthenticationProvider</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>auth</code> - The Authentication object to be authenticated.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The authenticated Authentication object, with it's grantedAuthorities set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a></code> - This implementation does not handle 'locked' or
'disabled' accounts. This method only throws a AuthenticationServiceException, with
the message of the LoginException that will be thrown, should the
loginContext.login() method fail.</dd>
</dl>
</li>
</ul>
<a id="createLoginContext(javax.security.auth.callback.CallbackHandler)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>createLoginContext</h4>
<pre class="methodSignature">protected abstract&nbsp;javax.security.auth.login.LoginContext&nbsp;createLoginContext&#8203;(javax.security.auth.callback.CallbackHandler&nbsp;handler)
                                                                      throws javax.security.auth.login.LoginException</pre>
<div class="block">Creates the LoginContext to be used for authentication.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>handler</code> - The CallbackHandler that should be used for the LoginContext (never
<code>null</code>).</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the LoginContext to use for authentication.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>javax.security.auth.login.LoginException</code></dd>
</dl>
</li>
</ul>
<a id="handleLogout(org.springframework.security.core.session.SessionDestroyedEvent)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>handleLogout</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;handleLogout&#8203;(<a href="../../core/session/SessionDestroyedEvent.html" title="class in org.springframework.security.core.session">SessionDestroyedEvent</a>&nbsp;event)</pre>
<div class="block">Handles the logout by getting the security contexts for the destroyed session and
invoking <code>LoginContext.logout()</code> for any which contain a
<code>JaasAuthenticationToken</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>event</code> - the session event which contains the current session</dd>
</dl>
</li>
</ul>
<a id="onApplicationEvent(org.springframework.security.core.session.SessionDestroyedEvent)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>onApplicationEvent</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;onApplicationEvent&#8203;(<a href="../../core/session/SessionDestroyedEvent.html" title="class in org.springframework.security.core.session">SessionDestroyedEvent</a>&nbsp;event)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>onApplicationEvent</code>&nbsp;in interface&nbsp;<code>org.springframework.context.ApplicationListener&lt;<a href="../../core/session/SessionDestroyedEvent.html" title="class in org.springframework.security.core.session">SessionDestroyedEvent</a>&gt;</code></dd>
</dl>
</li>
</ul>
<a id="publishFailureEvent(org.springframework.security.authentication.UsernamePasswordAuthenticationToken,org.springframework.security.core.AuthenticationException)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>publishFailureEvent</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;publishFailureEvent&#8203;(<a href="../UsernamePasswordAuthenticationToken.html" title="class in org.springframework.security.authentication">UsernamePasswordAuthenticationToken</a>&nbsp;token,
                                   <a href="../../core/AuthenticationException.html" title="class in org.springframework.security.core">AuthenticationException</a>&nbsp;ase)</pre>
<div class="block">Publishes the <a href="event/JaasAuthenticationFailedEvent.html" title="class in org.springframework.security.authentication.jaas.event"><code>JaasAuthenticationFailedEvent</code></a>. Can be overridden by
subclasses for different functionality</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>token</code> - The authentication token being processed</dd>
<dd><code>ase</code> - The exception that caused the authentication failure</dd>
</dl>
</li>
</ul>
<a id="publishSuccessEvent(org.springframework.security.authentication.UsernamePasswordAuthenticationToken)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>publishSuccessEvent</h4>
<pre class="methodSignature">protected&nbsp;void&nbsp;publishSuccessEvent&#8203;(<a href="../UsernamePasswordAuthenticationToken.html" title="class in org.springframework.security.authentication">UsernamePasswordAuthenticationToken</a>&nbsp;token)</pre>
<div class="block">Publishes the <a href="event/JaasAuthenticationSuccessEvent.html" title="class in org.springframework.security.authentication.jaas.event"><code>JaasAuthenticationSuccessEvent</code></a>. Can be overridden by
subclasses for different functionality.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>token</code> - The token being processed</dd>
</dl>
</li>
</ul>
<a id="setAuthorityGranters(org.springframework.security.authentication.jaas.AuthorityGranter[])">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setAuthorityGranters</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAuthorityGranters&#8203;(<a href="AuthorityGranter.html" title="interface in org.springframework.security.authentication.jaas">AuthorityGranter</a>[]&nbsp;authorityGranters)</pre>
<div class="block">Set the AuthorityGranters that should be consulted for role names to be granted to
the Authentication.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>authorityGranters</code> - AuthorityGranter array</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JaasAuthenticationProvider.html" title="class in org.springframework.security.authentication.jaas"><code>JaasAuthenticationProvider</code></a></dd>
</dl>
</li>
</ul>
<a id="setCallbackHandlers(org.springframework.security.authentication.jaas.JaasAuthenticationCallbackHandler[])">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setCallbackHandlers</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setCallbackHandlers&#8203;(<a href="JaasAuthenticationCallbackHandler.html" title="interface in org.springframework.security.authentication.jaas">JaasAuthenticationCallbackHandler</a>[]&nbsp;callbackHandlers)</pre>
<div class="block">Set the JAASAuthentcationCallbackHandler array to handle callback objects generated
by the LoginContext.login method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>callbackHandlers</code> - Array of JAASAuthenticationCallbackHandlers</dd>
</dl>
</li>
</ul>
<a id="setLoginContextName(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoginContextName</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setLoginContextName&#8203;(java.lang.String&nbsp;loginContextName)</pre>
<div class="block">Set the loginContextName, this name is used as the index to the configuration
specified in the loginConfig property.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>loginContextName</code> - </dd>
</dl>
</li>
</ul>
<a id="setLoginExceptionResolver(org.springframework.security.authentication.jaas.LoginExceptionResolver)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setLoginExceptionResolver</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setLoginExceptionResolver&#8203;(<a href="LoginExceptionResolver.html" title="interface in org.springframework.security.authentication.jaas">LoginExceptionResolver</a>&nbsp;loginExceptionResolver)</pre>
</li>
</ul>
<a id="supports(java.lang.Class)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>supports</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;supports&#8203;(java.lang.Class&lt;?&gt;&nbsp;aClass)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../AuthenticationProvider.html#supports(java.lang.Class)">AuthenticationProvider</a></code></span></div>
<div class="block">Returns <code>true</code> if this <Code>AuthenticationProvider</Code> supports the
indicated <Code>Authentication</Code> object.
<p>
Returning <code>true</code> does not guarantee an
<code>AuthenticationProvider</code> will be able to authenticate the presented
instance of the <code>Authentication</code> class. It simply indicates it can
support closer evaluation of it. An <code>AuthenticationProvider</code> can still
return <code>null</code> from the <a href="../AuthenticationProvider.html#authenticate(org.springframework.security.core.Authentication)"><code>AuthenticationProvider.authenticate(Authentication)</code></a> method to
indicate another <code>AuthenticationProvider</code> should be tried.
</p>
<p>
Selection of an <code>AuthenticationProvider</code> capable of performing
authentication is conducted at runtime the <code>ProviderManager</code>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../AuthenticationProvider.html#supports(java.lang.Class)">supports</a></code>&nbsp;in interface&nbsp;<code><a href="../AuthenticationProvider.html" title="interface in org.springframework.security.authentication">AuthenticationProvider</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>true</code> if the implementation can more closely evaluate the
<code>Authentication</code> class presented</dd>
</dl>
</li>
</ul>
<a id="setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>setApplicationEventPublisher</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setApplicationEventPublisher&#8203;(org.springframework.context.ApplicationEventPublisher&nbsp;applicationEventPublisher)</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>setApplicationEventPublisher</code>&nbsp;in interface&nbsp;<code>org.springframework.context.ApplicationEventPublisherAware</code></dd>
</dl>
</li>
</ul>
<a id="getApplicationEventPublisher()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getApplicationEventPublisher</h4>
<pre class="methodSignature">protected&nbsp;org.springframework.context.ApplicationEventPublisher&nbsp;getApplicationEventPublisher()</pre>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="AbstractJaasAuthenticationProvider.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="AbstractJaasAuthenticationProvider.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040cda8f9bc980c","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
